﻿' LibWowAPI
' by Ronald M. Clifford (roncli@roncli.com)
'
' This source code is released under the GNU Library General Public License (LGPL) Version 2.1.

Namespace roncliProductions.LibWowAPI.Item

    ''' <summary>
    ''' A class containing information about a spell used by an item.
    ''' </summary>
    ''' <remarks></remarks>
    Public Class ItemSpell

        ''' <summary>
        ''' The spell ID number.
        ''' </summary>
        ''' <value></value>
        ''' <returns></returns>
        ''' <remarks></remarks>
        Public Property SpellID As Integer

        ''' <summary>
        ''' The spell details.
        ''' </summary>
        ''' <value></value>
        ''' <returns></returns>
        ''' <remarks></remarks>
        Public Property Spell As Spell

        ''' <summary>
        ''' The number of charges available.
        ''' </summary>
        ''' <value></value>
        ''' <returns></returns>
        ''' <remarks>Returns 0 if the item doesn't use charges.</remarks>
        Public Property Charges As Integer

        ''' <summary>
        ''' Determins whether the spell is consumed on cast.
        ''' </summary>
        ''' <value></value>
        ''' <returns></returns>
        ''' <remarks></remarks>
        Public Property Consumable As Boolean

        ''' <summary>
        ''' The spell category ID number.
        ''' </summary>
        ''' <value></value>
        ''' <returns></returns>
        ''' <remarks></remarks>
        Public Property CategoryID As Integer

        Protected Friend Sub New(intSpellID As Integer, sSpell As Spell, intCharges As Integer, blnConsumable As Boolean, intCategoryID As Integer)
            SpellID = intSpellID
            Spell = sSpell
            Charges = intCharges
            Consumable = blnConsumable
            CategoryID = intCategoryID
        End Sub

    End Class

End Namespace
